Skip to content

Simplify Network Broker config generation instructions#2418

Open
matthewdean-semgrep wants to merge 1 commit into
mainfrom
matthewdean/broker-setup-steps
Open

Simplify Network Broker config generation instructions#2418
matthewdean-semgrep wants to merge 1 commit into
mainfrom
matthewdean/broker-setup-steps

Conversation

@matthewdean-semgrep
Copy link
Copy Markdown
Contributor

@matthewdean-semgrep matthewdean-semgrep commented Dec 2, 2025

The docs were written before we provided a starter config and before Network Broker supported fetching information like public key from DNS records. This updates the instructions for >v0.25.0 to omit unnecessary fields and streamline the setup. Note that this does create a dependence from Broker on DNS which previously did not exist so we want to carefully assess this change in recommendations.

As a side effect, this buries the explanation of how to manually generate Broker local addresses under the legacy section which is hidden by default.

Before:
image

After:
image

  • A subject matter expert (SME) reviews the content
  • A technical writer reviews the content or PR
  • This change has no security implications or else you have pinged the security team
  • Redirects are added if the PR changes page URLs
  • If you have changed any header tag links (doc/#this-kind-of-anchor), update all instances of that link

@netlify
Copy link
Copy Markdown

netlify Bot commented Dec 2, 2025

Deploy Preview for semgrep-docs-prod ready!

Name Link
🔨 Latest commit bc62bed
🔍 Latest deploy log https://app.netlify.com/projects/semgrep-docs-prod/deploys/6a15d764f3cdc400089f697a
😎 Deploy Preview https://deploy-preview-2418--semgrep-docs-prod.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Collaborator

@khorne3 khorne3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some nits. Thank you!

Comment thread docs/semgrep-ci/network-broker.md Outdated
Comment thread docs/semgrep-ci/network-broker.md Outdated
Comment thread docs/semgrep-ci/network-broker.md Outdated
Comment thread docs/semgrep-ci/network-broker.md Outdated
Comment thread docs/semgrep-ci/network-broker.md Outdated
Comment thread docs/semgrep-ci/network-broker.md Outdated
Comment thread docs/semgrep-ci/network-broker.md Outdated
Comment thread docs/semgrep-ci/network-broker.md Outdated
@matthewdean-semgrep matthewdean-semgrep force-pushed the matthewdean/broker-setup-steps branch from db96c29 to bc62bed Compare May 26, 2026 17:24
@matthewdean-semgrep matthewdean-semgrep requested review from armchairlinguist and removed request for armchairlinguist and stuartcmehrens May 26, 2026 17:25
@matthewdean-semgrep
Copy link
Copy Markdown
Contributor Author

@armchairlinguist Can you take a look? Resurrecting this old PR as we've run into additional cases where lack of simplified instructions made Broker setup more complicated than it need be.

@matthewdean-semgrep matthewdean-semgrep marked this pull request as ready for review May 26, 2026 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants